Node / meshtastic / Meshtastic-Android / files / specs / 20260507-161858-app-docs-markdown / data-model.md

Displaying Rendered • View raw • Download

This feature introduces no Room entities and no durable database tables. Documentation content is packaged as build-time resources/assets and loaded into memory at runtime. Preferences are optional and limited to lightweight UX state (for example, remembering the last viewed section); the documentation corpus itself is never stored in Room.

The core runtime model is expressed as Kotlin T383838data class and T383838sealed interface types that can live in T383838feature/docs/src/commonMain/kotlin/... and be shared across Android, Desktop, and iOS.

Represents the top-level documentation buckets shown on the website and inside the app.

T282828

Tff7b72sealed Tff7b72interface T56d364DocSection Tb4b4b4{

Tf0883e@Serializable Tff7b72data Tff7b72object T56d364UserGuide Tb4b4b4: Te6edf3DocSection

Tf0883e@Serializable Tff7b72data Tff7b72object T56d364DeveloperGuide Tb4b4b4: Te6edf3DocSection

Tb4b4b4}

• Must map 1:1 to a top-level docs directory.

• Must be stable across releases so deep links and keyword index entries remain valid.

Represents a single documentation page regardless of how it is rendered on a target.

T282828

Tff7b72data Tff7b72class T56d364DocPageTb4b4b4(

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3titleTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sectionTb4b4b4: Te6edf3DocSectionTb4b4b4,

Tff7b72val Te6edf3navOrderTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72val Te6edf3resourcePathTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3keywordsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4,

Tff7b72val Te6edf3aliasesTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tff7b72val Te6edf3charCountTb4b4b4: Tffa657IntTb4b4b4,

Tb4b4b4)

• T383838id must be unique across the full corpus.

• T383838navOrder must be non-negative.

• T383838resourcePath must resolve in the packaged bundle for every supported target.

• T383838charCount must be T383838> 0.

• Immutable after load.

• Replaced only when the shipped app version changes.

Decouples metadata from actual content so different targets can choose HTML or markdown rendering.

T282828

Tff7b72data Tff7b72class T56d364DocPageContentTb4b4b4(

Tff7b72val Te6edf3pageTb4b4b4: Te6edf3DocPageTb4b4b4,

Tff7b72val Te6edf3htmlTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3markdownTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3cssPathTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)

• Android normally prefers T383838html.

• Desktop/iOS may prefer T383838markdown for Compose rendering, or T383838html if an embedded browser implementation is chosen.

• At least one of T383838html or T383838markdown must be present for each page.

Runtime aggregate of the full packaged documentation corpus.

T282828

Tff7b72data Tff7b72class T56d364DocBundleTb4b4b4(

Tff7b72val Te6edf3pagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4,

Tff7b72val Te6edf3pageIndexTb4b4b4: Te6edf3MapTff7b72<Tffa657StringTb4b4b4, Te6edf3DocPageTff7b72>Tb4b4b4,

Tff7b72val Te6edf3bundleVersionTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3generatedAtTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3totalBytesTb4b4b4: Tffa657LongTb4b4b4,

Tb4b4b4)

T282828

Tff7b72interface T56d364DocBundleLoader Tb4b4b4{

Tff7b72suspend Tff7b72fun Td2a8ffloadTb4b4b4(Tb4b4b4)Tb4b4b4: Te6edf3DocBundle

Tff7b72suspend Tff7b72fun Td2a8ffreadPageTb4b4b4(Te6edf3pageIdTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Te6edf3DocPageContent?

Tff7b72fun Td2a8ffpagesBySectionTb4b4b4(Te6edf3sectionTb4b4b4: Te6edf3DocSectionTb4b4b4)Tb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>

Tb4b4b4}

• T383838pagesBySection() sorts by T383838navOrder, then title.

• T383838pageIndex.keys == pages.map { it.id }.toSet().

• T383838totalBytes <= 10_485_760 for release-ready bundles.

Build-time artifact decoded at runtime for keyword search and AI retrieval.

T282828

Tff7b72data Tff7b72class T56d364KeywordIndexEntryTb4b4b4(

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3titleTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sectionTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3resourcePathTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3navOrderTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72val Te6edf3keywordsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4,

Tff7b72val Te6edf3aliasesTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tff7b72val Te6edf3charCountTb4b4b4: Tffa657IntTb4b4b4,

Tb4b4b4)

• Must match the JSON schema in T383838contracts/keyword-index-schema.json.

• Every entry must correspond to exactly one bundled page.

Used by the shared keyword-search fallback and by Gemini Nano retrieval pre-ranking.

T282828

Tff7b72data Tff7b72class T56d364DocSearchQueryTb4b4b4(

Tff7b72val Te6edf3rawTextTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3normalizedTermsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4,

Tb4b4b4)

Tff7b72data Tff7b72class T56d364DocSearchResultTb4b4b4(

Tff7b72val Te6edf3pageTb4b4b4: Te6edf3DocPageTb4b4b4,

Tff7b72val Te6edf3scoreTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72val Te6edf3matchedTermsTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72>Tb4b4b4,

Tb4b4b4)

• Exact keyword matches score higher than alias matches.

• Title matches outrank body-keyword matches.

• T383838navOrder breaks ties within a section.

Shared abstraction over the platform-specific docs assistant.

T282828

Tff7b72interface T56d364AIDocAssistant Tb4b4b4{

T8b949e/** Answer a user question about Meshtastic using bundled documentation context. */

Tff7b72suspend Tff7b72fun Td2a8ffanswerTb4b4b4(Te6edf3questionTb4b4b4: Tffa657StringTb4b4b4, Te6edf3currentPageIdTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4: Te6edf3AIDocAssistantResult

T8b949e/** Answer a user question about Meshtastic, streaming the results as they arrive. */

Tff7b72fun Td2a8ffanswerStreamTb4b4b4(

Te6edf3questionTb4b4b4: Tffa657StringTb4b4b4,

Te6edf3currentPageIdTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3kotlinxTb4b4b4.Te6edf3coroutinesTb4b4b4.Te6edf3flowTb4b4b4.Te6edf3FlowTff7b72<Te6edf3AIDocAssistantResultTff7b72>

Tb4b4b4}

Possible runtime result model:

T282828

Tff7b72sealed Tff7b72interface T56d364AIDocAssistantResult Tb4b4b4{

Tff7b72data Tff7b72class T56d364PartialTb4b4b4(

Tff7b72val Te6edf3answerTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sourcePagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4,

Tff7b72val Te6edf3usedOnDeviceModelTb4b4b4: Tffa657BooleanTb4b4b4,

Tb4b4b4) Tb4b4b4: Te6edf3AIDocAssistantResult

Tff7b72data Tff7b72class T56d364SuccessTb4b4b4(

Tff7b72val Te6edf3answerTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sourcePagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4,

Tff7b72val Te6edf3usedOnDeviceModelTb4b4b4: Tffa657BooleanTb4b4b4,

Tb4b4b4) Tb4b4b4: Te6edf3AIDocAssistantResult

Tff7b72data Tff7b72class T56d364FallbackTb4b4b4(

Tff7b72val Te6edf3messageTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3suggestedPagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4,

Tb4b4b4) Tb4b4b4: Te6edf3AIDocAssistantResult

Tff7b72data Tff7b72class T56d364ErrorTb4b4b4(

Tff7b72val Te6edf3reasonTb4b4b4: Te6edf3DocsAiErrorTb4b4b4,

Tff7b72val Te6edf3suggestedPagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tb4b4b4) Tb4b4b4: Te6edf3AIDocAssistantResult

Tb4b4b4}

Associated error model:

T282828

Tff7b72sealed Tff7b72interface T56d364DocsAiError Tb4b4b4{

Tff7b72data Tff7b72object T56d364UnsupportedPlatform Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364UnsupportedFlavor Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364ModelUnavailable Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364Busy Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364TokenBudgetExceeded Tb4b4b4: Te6edf3DocsAiError

Tff7b72data Tff7b72object T56d364Unknown Tb4b4b4: Te6edf3DocsAiError

Tb4b4b4}

• Android T383838google flavor may return T383838Success using Gemini Nano.

• T383838fdroid, Desktop, and iOS normally return T383838Fallback or T383838UnsupportedPlatform and provide suggested pages.

UI state for the Chirpy conversation surface.

T282828

Tff7b72data Tff7b72class T56d364AIDocAssistantSessionStateTb4b4b4(

Tff7b72val Te6edf3messagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3ChirpyMessageTff7b72>Tb4b4b4,

Tff7b72val Te6edf3isLoadingTb4b4b4: Tffa657BooleanTb4b4b4,

Tff7b72val Te6edf3draftQuestionTb4b4b4: Tffa657StringTb4b4b4,

Tb4b4b4)

Tf0883e@Serializable

Tff7b72data Tff7b72class T56d364SourceRefTb4b4b4(

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3titleTb4b4b4: Tffa657StringTb4b4b4,

Tb4b4b4)

Tf0883e@Serializable

Tff7b72data Tff7b72class T56d364ChirpyMessageTb4b4b4(

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3roleTb4b4b4: Te6edf3ChirpyRoleTb4b4b4,

Tff7b72val Te6edf3textTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3sourcesTb4b4b4: Te6edf3ListTff7b72<Te6edf3SourceRefTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tb4b4b4)

Tf0883e@Serializable

Tff7b72enum Tff7b72class T56d364ChirpyRole Tb4b4b4{ Te6edf3USERTb4b4b4, Te6edf3ASSISTANTTb4b4b4, Te6edf3SYSTEM Tb4b4b4}

• Session state is ephemeral and resets when the screen/process is recreated unless explicitly made saveable.

• Messages are not persisted to Room.

T282828

• No Room tables are required for documentation content.

• No migration story is required for docs content because the corpus is versioned with the app binary.

• Optional UX-only settings (for example, last-opened section) may live in T383838core:prefs, but they are intentionally excluded from this feature’s core data model.